The CxMssBlackoutEditor object contains the following methods:
The Connect method connects to a MSS.
Connect(DomainSiteService As String)
| Parameter | Required | Description |
|---|---|---|
|
DomainSiteService |
Yes |
The [Domain]Site.Service to which to connect. A domain is optional. The service must be a valid MSS. |
Example
The following example creates and connects the CxMssBlackoutEditor object.
|
Sub Dim MssBlackoutEditor Set MssBlackoutEditor = CreateObject("CxEditors.CxMssBlackoutEditor") MssBlackoutEditor.Connect("[5410]CYGDEMO.MSS") End Sub |
The Copy method launches a New Blackout property sheet initialized with the information in the specified record.
Copy(QueueKey As String) As Integer
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to copy. |
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a New Blackout property sheet for record "0000000012A0000001."
|
Sub Dim iRet iRet= MssBlackoutEditor.Copy("0000000012A0000001") MsgBox iRet End Sub |
This method is unimplemented.
The Disconnect method disconnects from the connected MSS service.
Disconnect()
Example
The following example disconnects the MssBlackoutEditor object.
|
Sub MssBlackoutEditor.Disconnect End Sub |
The Edit method launches a property sheet for the specified record.
Edit(QueueKey As String) As Integer
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to edit. |
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a property sheet for record "0000000012A0000001."
|
Sub Dim iRet iRet= MssBlackoutEditor.Edit("0000000012A0000001") MsgBox iRet End Sub |
The New method launches a New Blackout property sheet.
New() As Integer
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a New Blackout property sheet.
|
Sub Dim iRet iRet= MssBlackoutEditor.New MsgBox iRet End Sub |
|
|
|
